documents folder

Type

property

Summary

Returns the path to the current user's documents folder.

Syntax

the documents folder

Description

Returns the full path to the current user's documents folder.

On Mac OS X and Windows the documents folder property returns the path to the user's documents folder.

On iOS the documents folder property returns the folder in which the application should store any document data (this folder is backed up by iTunes on sync).

On Android the documents folder property returns the path to a folder that can be used for per-application data files.

This property is read only and is equivalent to the specialFolderPath("documents") function.

Examples

get the documents folder

put the documents folder & "/music" into tUserMusicFolder

Related

function: specialFolderPath

property: engine folder, desktop folder, home folder, temporary folder

Compatibility and Support

Introduced

LiveCode 5.0.2

OS

mac

windows

ios

android

Platforms

desktop

mobile